no issue - introduce anonymizator Context #235
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
pounard
force-pushed
the
anonymizator-context
branch
from
5ff2c62 to
4b229a3
Compare
pounard
force-pushed
the
anonymizator-context
branch
2 times, most recently
from
53c9e20 to
be29e73
Compare
pounard
force-pushed
the
anonymizator-context
branch
from
be29e73 to
eba1c0f
Compare
Member
Author
|
Following our discussions on matrix, I did remove the bc layer, rationale being:
Impact for most if not all users should null. |
Comment on lines
+80
to
84
| #[\Deprecated(message: "Will be removed in 3.0, use \$this->context->salt instead.", since: "2.1.0")] | ||
| protected function getSalt(): string | ||
| { | ||
| return $this->options->get('salt') ?? Anonymizator::generateRandomSalt(); | ||
| return $this->context->salt; | ||
| } |
Member
There was a problem hiding this comment.
I think we can directly get rid of this
Comment on lines
-50
to
58
| private AnonymizationConfig $anonymizationConfig, | ||
| private ?string $salt = null, | ||
| ?Context $defaultContext = null, | ||
| ) { | ||
| $this->logger = new NullLogger(); | ||
| $this->output = new NullOutput(); | ||
| $this->defaultContext = $defaultContext ?? new Context(); | ||
| } | ||
|
|
Member
There was a problem hiding this comment.
I in favor of keeping things the most simple as we can. Here, can we use the both options for the $defaultContext property ?
- If we always give a
$defaultContext, I think we should not accept it to be null. - If we never give a
$defaultContext, then we should remove it from params and always prepopulate it in constructor.
I think we should not introduce behavior we don't need because it is more code to maintain, and it makes things more complicated to understand.
| } | ||
|
|
||
| $plan = []; | ||
| $context = clone $this->defaultContext; |
Member
There was a problem hiding this comment.
Given taht $context is readonly in AbstractAnonymizer, why do you need to clone it here ?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
In many occasions, we need to share context for a single anonyzation run between anonymizers:
All this data must go directly to anonymizers, but using the
Optionsinstance is wrong:The less impactful solution I found is the following:
Contextclass, which will carry all this information.AbstractAnonymizerin order to accept this new parameter.But we have a problem here, it's BC break, and a huge one, it will cause a refactor of all our tests, and possibly create problems with existing custom anonymizers in the wild (I guess there's not much, but you never know). This can be mitigated by the fact that people should extend our abstract implementations and probably won't override the constructor, but you never know, it's public API now.
So, temporary ulgy solution:
ContextextendOptions(even if it makes no sense) and pass it toAbstractAnonymizer::__construct(): no signature change needed.AbstractAnonymizer::__construct()to check validity of input, and create a dummyContextinstance whenOptionsare passed instead.Options $optionsandContext $context(which will not extendOptionsanymore).